Skip to content

feat: GitHub polish + MCP quickstart (specs 23 & 25)#47

Merged
DarlingtonDeveloper merged 1 commit into
mainfrom
spec-23-25-github-polish-mcp-quickstart
Mar 21, 2026
Merged

feat: GitHub polish + MCP quickstart (specs 23 & 25)#47
DarlingtonDeveloper merged 1 commit into
mainfrom
spec-23-25-github-polish-mcp-quickstart

Conversation

@mikeajijola
Copy link
Copy Markdown
Contributor

What this PR does

Implements Spec 25 (GitHub Polish) and Spec 23 (MCP Quickstart & README Integration).

Spec 25 — GitHub Polish

  • README badges: CI, Release, crates.io, PyPI, npm, License
  • Issue templates: bug report, feature request
  • PR template with checklist
  • .github/FUNDING.yml for Sponsor button
  • Social preview image (1280x640 SVG + PNG) in docs/assets/
  • npm publish job for mcp-bridge added to release workflow

Spec 23 — MCP Quickstart

  • 'Use with AI Agents (MCP)' section in README with copy-paste configs for Claude Code, Cursor, Windsurf, VS Code
  • 7-tool reference table in README
  • Full docs/guides/mcp-setup.md guide (Options A/B/C, tool parameters, best practices, troubleshooting)
  • MCP Setup linked from README Documentation section
  • mcp-bridge/package.json for npx cortex-mcp-bridge support
  • CLAUDE.md updated with MCP architecture section (library vs proxy mode)

Manual steps still needed after merge

  1. Set repo description, topics, and website URL via GitHub Settings
  2. Upload docs/assets/social-preview.png via GitHub Settings > Social preview
  3. Add NPM_TOKEN secret for the mcp-bridge publish job

Checklist

  • Tests pass (cargo test --workspace — no code changes, docs only)
  • Docs updated (README, CLAUDE.md, new guides)
  • CHANGELOG updated (if notable change) — N/A, docs-only

Spec 25 - GitHub Polish:
- Add CI, Release, crates.io, PyPI, npm, License badges to README
- Create issue templates (bug report, feature request)
- Create PR template with checklist
- Add .github/FUNDING.yml for Sponsor button
- Create social preview image (1280x640 SVG + PNG)
- Add mcp-bridge npm publish job to release workflow

Spec 23 - MCP Quickstart:
- Add 'Use with AI Agents (MCP)' section to README
- Copy-paste configs for Claude Code, Cursor, Windsurf, VS Code
- Create docs/guides/mcp-setup.md with full setup guide
- Document all 7 MCP tools with parameters
- Add troubleshooting section
- Create mcp-bridge/package.json for npx support
- Update CLAUDE.md with MCP architecture section
- Link MCP setup from README Documentation section
@DarlingtonDeveloper DarlingtonDeveloper merged commit c036caa into main Mar 21, 2026
3 checks passed
@DarlingtonDeveloper DarlingtonDeveloper deleted the spec-23-25-github-polish-mcp-quickstart branch March 21, 2026 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants